Endpoint Configuration by ID
Route
/v2/endpoint-management/configurations/{id}
Description
Retrieve a configuration module, update its metadata or JSON overrides, or delete it when no longer needed.
Methods
- GET — fetch a configuration by ID
- PATCH — update configuration fields
- DELETE — delete a configuration
Inputs
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Configuration ID in the path |
configuration | UpdateConfiguration | Yes (PATCH) | Fields to update (name, description, config) |
fields | string | No (PATCH) | Comma-separated list of fields to update |
Request Example (PATCH)
{
"name": "High Security Sensor Config",
"description": "Updated messaging for the profile",
"config": {
"perf.cpu_limit": 75
}
}
Output (GET/PATCH)
| Field | Type | Description |
|---|---|---|
type | string | Always "configurations" |
size | integer | Number of configurations returned |
resources | array[Configuration] | Configuration object |
errors | array[Error] | Any errors |
Configuration Object (key fields)
| Field | Type | Description |
|---|---|---|
id | string | Configuration identifier |
name | string | Configuration name |
description | string | Description |
is_default | boolean | Whether this is the default |
type | string | Configuration type |
version | integer | Version number |
used_in_profiles | array[ProfileDetails] | Profiles that consume this configuration |
config | object | JSON payload with overrides |
Rate Limit
- 60 requests per minute per API key
- 5 concurrent requests per endpoint
Example Response (GET)
{
"type": "configurations",
"size": 1,
"resources": [
{
"id": "config-123e4567-e89b-12d3-a456-426614174000",
"name": "High Security Sensor Config",
"description": "Updated messaging for the profile",
"is_default": false,
"type": "performance",
"version": 2,
"config": {
"perf.cpu_limit": 75
}
}
],
"errors": []
}